home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / os30 / wb / WBVerlauf20.lha / WBVerlauf.doc < prev    next >
Text File  |  1993-08-05  |  7KB  |  168 lines
  1. WBVerlauf                                                           WBVerlauf
  2.  
  3.    NAME
  4.         WBVerlauf - Create background copper list on the Workbench screen
  5.  
  6.  
  7.    LEGAL STUFF
  8.         Copyright ©1992, 1993 by Christian A. Weber, Zürich, Switzerland.
  9.  
  10.         THIS PROGRAM AND ITS DOCUMENTATION MAY BE DISTRIBUTED FOR
  11.         NON-PROFIT PURPOSE ONLY. IT MAY NOT BE MODIFIED IN ANY WAY
  12.         WITHOUT THE PRIOR WRITTEN PERMISSION OF THE AUTHOR.
  13.         USE AT YOUR OWN RISK. NO WARRANTY. NO REFUNDS. NO CARRIER.
  14.  
  15.         IT IS ILLEGAL TO DISTRIBUTE THIS PROGRAM ON DISKS WHICH COST
  16.         MORE THAN US $5 PER FLOPPY DISK, OR MORE THAN US $50 PER CD.
  17.  
  18.  
  19.    REQUIREMENTS
  20.         - Amiga with AGA chipset (currently A1200, A4000 and CD32)
  21.         - At least 68EC020 processor (as found in the A1200)
  22.         - Kickstart 3.0 or newer
  23.         - Color monitor :-)
  24.  
  25.  
  26.    INSTALLATION
  27.         To install WBVerlauf permanently in your system, just copy
  28.         the WBVerlauf program into your WBStartup drawer.
  29.  
  30.  
  31.    DESCRIPTION
  32.         WBVerlauf lets you create rainbow color effects for a selectable
  33.         pen color number on the Workbench screen, using the entire
  34.         16 million color range of the AGA chips.
  35.  
  36.         You specify the color of the first and the last line of the screen,
  37.         and WBVerlauf will make a smooth color change by setting a new
  38.         color value on every scanline.
  39.  
  40.         Example: I have an 8 color Workbench, and I set the Workbench's
  41.                  background color to color 4 (using the WBPattern prefs
  42.                  editor). Then I set the COLORNUMBER tooltype to 4, so
  43.                  only the Workbench's color gets changed by WBVerlauf.
  44.                  This looks very nice (the icon is designed for this case).
  45.  
  46.         You can use the built-in configuration window to add or remove
  47.         color effects. A set of built-in effects is provided to get you
  48.         started quickly.
  49.  
  50.  
  51.    TOOLTYPES
  52.         WBVerlauf recognizes the following tooltypes, which can be
  53.         changed by clicking on the WBVerlauf icon and selecting
  54.         "Information..." from Workbench's "Icon"-menu:
  55.  
  56.         Name         Example     Function
  57.         --------------------------------------------------------------
  58.         CX_POPKEY    ctrl alt w  Selects the key which will open
  59.                                  the configuration window
  60.  
  61.         CX_POPUP     Yes | No    If set to Yes, the configuration
  62.                                  window will open whenever the
  63.                                  program is run.
  64.  
  65.         CX_PRIORITY  0           Not very useful. Just ignore it.
  66.  
  67.         COLORNUMBER  4           Pen number of the color to change.
  68.                                  A value of 0 means background color,
  69.                                  1 is normally the text color,
  70.                                  3 is for window borders, etc.
  71.                                  Must be in the range of 0 to 255.
  72.  
  73.         STEP         4           Number of lines between color changes.
  74.                                  Defaults to 3. If you have a fast
  75.                                  processor, you may set this to 2 or 1,
  76.                                  which will look a tad better, but gives
  77.                                  slower screen dragging.
  78.  
  79.         BORDERBLANK              If this tooltype is present, WBVerlauf
  80.                                  will change the border color to black.
  81.                                  This is on by default.
  82.  
  83.         RANDOMFX                 If present, WBVerlauf picks a random
  84.                                  effect out of your effect list rather
  85.                                  than using the active one.
  86.  
  87.         EFFECT                   These are the effect entries. You should
  88.                                  use the configuration window to change
  89.                                  them, and not edit the tooltypes directly.
  90.  
  91.         The effects are stored in the following format:
  92.  
  93.         EFFECT <startcolor> <endcolor> <flags> <name>
  94.  
  95.         startcolor - A six digit hexadecimal number specifying the
  96.                      color of the first line of the screen. The first
  97.                      two digits select the red level, the next two
  98.                      digits the green and the last two digits the blue
  99.                      level. So a startcolor of 0xF765E3 would give you
  100.                      a nice pink (0xF7 for red, 0x65 for green and
  101.                      0xE3 for blue; 00 is dark and FF is bright).
  102.  
  103.         endcolor   - A six digit hexadecimal number specifying the
  104.                      color of the last line of the screen.
  105.  
  106.         flags      - Bit 0: If set, this effect is selected. Only one
  107.                             effect may have this bit set at a time.
  108.                      Bit 4: If set, 'startcolor' is ignored and a random
  109.                             number is used as start color.
  110.                      Bit 5: If set, 'endcolor' is ignored and a random
  111.                             number is used as end color.
  112.  
  113.         name       - The name of the effect.
  114.  
  115.  
  116.    WARNINGS
  117.         This program makes use of undocumented hardware components of the
  118.         AGA chips, and is not programmed according to Commodore rules.
  119.         It will not work with future hardware or software versions.
  120.         You must NOT use this code in professional applications.
  121.  
  122.  
  123.    TODO
  124.         If you have any suggestions, let me know! Currently, I'm
  125.         planning to add the following for the next release:
  126.  
  127.         - Random start- and ending colors can currently only be set
  128.           by directly editing tooltypes. The editor needs to support
  129.           this directly.
  130.         - Changing effects by hotkeys.
  131.  
  132.  
  133.    BUGS
  134.         Tell me about any you find!
  135.  
  136.  
  137.    AUTHOR
  138.         Christian A. Weber
  139.  
  140.         Internet:    weber@amiga.physik.unizh.ch, weber@pax.eunet.ch
  141.         UUCP:        chris@mighty.adsp.sub.org
  142.         Snail mail:  Bruggerweg 2, CH-8037 Zürich, Switzerland.
  143.  
  144.  
  145.    RELEASE NOTES
  146.         04-Aug-93  V2.0  - Sprite size change is faster
  147.                          - Doesn't loop anymore, uses less CPU time
  148.                          - WBVerlauf is now a commodity
  149.                          - Configuration window added
  150.                          - Localized to German and English
  151.  
  152.         19-May-93  V1.9  - WBVerlauf no longer locks the WB screen, so
  153.                            you can change screen modes while the
  154.                            program is running.
  155.  
  156.         05-Apr-93  V1.8  - Enforcer hit in copperlist routine removed
  157.  
  158.         09-Mar-93  V1.7  - RANDOM parameter for colors added
  159.  
  160.         15-Dec-92  V1.6  - Copper list optimized for better performance
  161.  
  162.         07-Dec-92  V1.5  - Horizontal mouse pointer resolution change
  163.                            works correctly (with a slight delay..)
  164.                          - Colornumbers above 32 work correctly now
  165.  
  166.         30-Nov-92  V1.4  Initial release
  167.  
  168.